<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.13" name="generator"/>
<title>OpenCV: cv::aruco::Dictionary Class Reference</title>
<link href="../../opencv.ico" rel="shortcut icon" type="image/x-icon"/>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script src="../../jquery.js" type="text/javascript"></script>
<script src="../../dynsections.js" type="text/javascript"></script>
<script src="../../tutorial-utils.js" type="text/javascript"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script src="../../search/searchdata.js" type="text/javascript"></script>
<script src="../../search/search.js" type="text/javascript"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
//<![CDATA[
MathJax.Hub.Config(
{
  TeX: {
      Macros: {
          matTT: [ "\\[ \\left|\\begin{array}{ccc} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{array}\\right| \\]", 9],
          fork: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ \\end{array} \\right.", 4],
          forkthree: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ \\end{array} \\right.", 6],
          forkfour: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ #7 & \\mbox{#8}\\\\ \\end{array} \\right.", 8],
          vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3],
          vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9],
          cameramatrix: ["#1 = \\begin{bmatrix} f_x & 0 & c_x\\\\ 0 & f_y & c_y\\\\ 0 & 0 & 1 \\end{bmatrix}", 1],
          distcoeffs: ["(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]]) \\text{ of 4, 5, 8, 12 or 14 elements}"],
          distcoeffsfisheye: ["(k_1, k_2, k_3, k_4)"],
          hdotsfor: ["\\dots", 1],
          mathbbm: ["\\mathbb{#1}", 1],
          bordermatrix: ["\\matrix{#1}", 1]
      }
  }
}
);
//]]>
</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js" type="text/javascript"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css"/>
<link href="../../stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<!--#include virtual="/google-search.html"-->
<table cellpadding="0" cellspacing="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="../../opencv-logo-small.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">OpenCV
    <span id="projectnumber">4.5.2</span>
   </div>
   <div id="projectbrief">Open Source Computer Vision</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script src="../../menudata.js" type="text/javascript"></script>
<script src="../../menu.js" type="text/javascript"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
  <ul>
<li class="navelem"><a class="el" href="../../d2/d75/namespacecv.html">cv</a></li><li class="navelem"><a class="el" href="../../d4/d17/namespacecv_1_1aruco.html">aruco</a></li><li class="navelem"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="../../d2/d29/classcv_1_1aruco_1_1Dictionary-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">cv::aruco::Dictionary Class Reference<div class="ingroups"><a class="el" href="../../d9/d6a/group__aruco.html">ArUco Marker Detection</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<p>Dictionary/Set of markers. It contains the inner codification.  
 <a href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#details">More...</a></p>
<p><code>#include &lt;opencv2/aruco/dictionary.hpp&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3954d49cd3dd1c9caf76b7951a1613fa"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a3954d49cd3dd1c9caf76b7951a1613fa">Dictionary</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;_bytesList=<a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>(), int _markerSize=0, int _maxcorr=0)</td></tr>
<tr class="separator:a3954d49cd3dd1c9caf76b7951a1613fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af17873363bfce8647d6b061c4e3d2245"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#af17873363bfce8647d6b061c4e3d2245">Dictionary</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; &amp;_dictionary)</td></tr>
<tr class="separator:af17873363bfce8647d6b061c4e3d2245"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b3199ddd6c9ca7ed04c3bdf88477d15"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a3b3199ddd6c9ca7ed04c3bdf88477d15">drawMarker</a> (int id, int sidePixels, <a class="el" href="../../dc/d84/group__core__basic.html#gaad17fda1d0f0d1ee069aebb1df2913c0">OutputArray</a> _img, int borderBits=1) const</td></tr>
<tr class="memdesc:a3b3199ddd6c9ca7ed04c3bdf88477d15"><td class="mdescLeft"> </td><td class="mdescRight">Draw a canonical marker image.  <a href="#a3b3199ddd6c9ca7ed04c3bdf88477d15">More...</a><br/></td></tr>
<tr class="separator:a3b3199ddd6c9ca7ed04c3bdf88477d15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af49505e713e72ead5314216d0c2842d7"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#af49505e713e72ead5314216d0c2842d7">getDistanceToId</a> (<a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> bits, int id, bool allRotations=true) const</td></tr>
<tr class="memdesc:af49505e713e72ead5314216d0c2842d7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the distance of the input bits to the specific id. If allRotations is true, the four posible bits rotation are considered.  <a href="#af49505e713e72ead5314216d0c2842d7">More...</a><br/></td></tr>
<tr class="separator:af49505e713e72ead5314216d0c2842d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82348e625eafe407794a4a757168b70d"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a82348e625eafe407794a4a757168b70d">identify</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;onlyBits, int &amp;idx, int &amp;rotation, double maxCorrectionRate) const</td></tr>
<tr class="memdesc:a82348e625eafe407794a4a757168b70d"><td class="mdescLeft"> </td><td class="mdescRight">Given a matrix of bits. Returns whether if marker is identified or not. It returns by reference the correct id (if any) and the correct rotation.  <a href="#a82348e625eafe407794a4a757168b70d">More...</a><br/></td></tr>
<tr class="separator:a82348e625eafe407794a4a757168b70d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a30601d33b623a8faa865d2ae68438624"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a30601d33b623a8faa865d2ae68438624">create</a> (int nMarkers, int <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a996eb5d27e061fedf0550092a6149ed7">markerSize</a>, int randomSeed=0)</td></tr>
<tr class="separator:a30601d33b623a8faa865d2ae68438624"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d5e1f226078215325731aaecd3e5046"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a6d5e1f226078215325731aaecd3e5046">create</a> (int nMarkers, int <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a996eb5d27e061fedf0550092a6149ed7">markerSize</a>, const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; &amp;baseDictionary, int randomSeed=0)</td></tr>
<tr class="separator:a6d5e1f226078215325731aaecd3e5046"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b0c74e3b15073ff11cbe10e99c6d654"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a1b0c74e3b15073ff11cbe10e99c6d654">get</a> (int dict)</td></tr>
<tr class="separator:a1b0c74e3b15073ff11cbe10e99c6d654"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a664bbc2de7b74b3ccf5ce459320a0337"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a664bbc2de7b74b3ccf5ce459320a0337">getBitsFromByteList</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;byteList, int <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a996eb5d27e061fedf0550092a6149ed7">markerSize</a>)</td></tr>
<tr class="memdesc:a664bbc2de7b74b3ccf5ce459320a0337"><td class="mdescLeft"> </td><td class="mdescRight">Transform list of bytes to matrix of bits.  <a href="#a664bbc2de7b74b3ccf5ce459320a0337">More...</a><br/></td></tr>
<tr class="separator:a664bbc2de7b74b3ccf5ce459320a0337"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af64929dff16f07347e6a449f48c78ec9"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#af64929dff16f07347e6a449f48c78ec9">getByteListFromBits</a> (const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp;bits)</td></tr>
<tr class="memdesc:af64929dff16f07347e6a449f48c78ec9"><td class="mdescLeft"> </td><td class="mdescRight">Transform matrix of bits to list of bytes in the 4 rotations.  <a href="#af64929dff16f07347e6a449f48c78ec9">More...</a><br/></td></tr>
<tr class="separator:af64929dff16f07347e6a449f48c78ec9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acd75143ec1fe49467dccc67503a66f07"><td align="right" class="memItemLeft" valign="top"><a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#acd75143ec1fe49467dccc67503a66f07">bytesList</a></td></tr>
<tr class="separator:acd75143ec1fe49467dccc67503a66f07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a996eb5d27e061fedf0550092a6149ed7"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a996eb5d27e061fedf0550092a6149ed7">markerSize</a></td></tr>
<tr class="separator:a996eb5d27e061fedf0550092a6149ed7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a729196b33a1a678a82f01f8e15d7864b"><td align="right" class="memItemLeft" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html#a729196b33a1a678a82f01f8e15d7864b">maxCorrectionBits</a></td></tr>
<tr class="separator:a729196b33a1a678a82f01f8e15d7864b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Dictionary/Set of markers. It contains the inner codification. </p>
<p>bytesList contains the marker codewords where</p><ul>
<li>bytesList.rows is the dictionary size</li>
<li>each marker is encoded using <code>nbytes = ceil(markerSize*markerSize/8.)</code></li>
<li>each row contains all 4 rotations of the marker, so its length is <code>4*nbytes</code></li>
</ul>
<p><code>bytesList.ptr(i)[k*nbytes + j]</code> is then the j-th byte of i-th marker, in its k-th rotation. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3954d49cd3dd1c9caf76b7951a1613fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3954d49cd3dd1c9caf76b7951a1613fa">◆ </a></span>Dictionary() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cv::aruco::Dictionary::Dictionary </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>_bytesList</em> = <code><a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a>()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>_markerSize</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>_maxcorr</em> = <code>0</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
</div>
</div>
<a id="af17873363bfce8647d6b061c4e3d2245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af17873363bfce8647d6b061c4e3d2245">◆ </a></span>Dictionary() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cv::aruco::Dictionary::Dictionary </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; &amp; </td>
          <td class="paramname"><em>_dictionary</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Dictionary(const Dictionary &amp;_dictionary); </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a30601d33b623a8faa865d2ae68438624"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30601d33b623a8faa865d2ae68438624">◆ </a></span>create() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt;<a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a>&gt; cv::aruco::Dictionary::create </td>
          <td>(</td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>nMarkers</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>markerSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>randomSeed</em> = <code>0</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Dictionary_create(</td><td class="paramname">nMarkers, markerSize[, randomSeed]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Dictionary_create_from(</td><td class="paramname">nMarkers, markerSize, baseDictionary[, randomSeed]</td><td>)</td></tr></table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="../../d9/d6a/group__aruco.html#gaedcb47348a8f7ccf0bd65ee81a8c7152">generateCustomDictionary</a> </dd></dl>
</div>
</div>
<a id="a6d5e1f226078215325731aaecd3e5046"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d5e1f226078215325731aaecd3e5046">◆ </a></span>create() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt;<a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a>&gt; cv::aruco::Dictionary::create </td>
          <td>(</td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>nMarkers</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>markerSize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; &amp; </td>
          <td class="paramname"><em>baseDictionary</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>randomSeed</em> = <code>0</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Dictionary_create(</td><td class="paramname">nMarkers, markerSize[, randomSeed]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Dictionary_create_from(</td><td class="paramname">nMarkers, markerSize, baseDictionary[, randomSeed]</td><td>)</td></tr></table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="../../d9/d6a/group__aruco.html#gaedcb47348a8f7ccf0bd65ee81a8c7152">generateCustomDictionary</a> </dd></dl>
</div>
</div>
<a id="a3b3199ddd6c9ca7ed04c3bdf88477d15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b3199ddd6c9ca7ed04c3bdf88477d15">◆ </a></span>drawMarker()</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cv::aruco::Dictionary::drawMarker </td>
          <td>(</td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>sidePixels</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#gaad17fda1d0f0d1ee069aebb1df2913c0">OutputArray</a> </td>
          <td class="paramname"><em>_img</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>borderBits</em> = <code>1</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>_img</td><td>=</td><td>cv.aruco_Dictionary.drawMarker(</td><td class="paramname">id, sidePixels[, _img[, borderBits]]</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Draw a canonical marker image. </p>
</div>
</div>
<a id="a1b0c74e3b15073ff11cbe10e99c6d654"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b0c74e3b15073ff11cbe10e99c6d654">◆ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt;<a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a>&gt; cv::aruco::Dictionary::get </td>
          <td>(</td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>dict</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Dictionary_get(</td><td class="paramname">dict</td><td>)</td></tr></table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="../../d9/d6a/group__aruco.html#gaf5d7e909fe8ff2ad2108e354669ecd17" title="Returns one of the predefined dictionaries defined in PREDEFINED_DICTIONARY_NAME. ...">getPredefinedDictionary</a> </dd></dl>
</div>
</div>
<a id="a664bbc2de7b74b3ccf5ce459320a0337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a664bbc2de7b74b3ccf5ce459320a0337">◆ </a></span>getBitsFromByteList()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> cv::aruco::Dictionary::getBitsFromByteList </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>byteList</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>markerSize</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Dictionary_getBitsFromByteList(</td><td class="paramname">byteList, markerSize</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Transform list of bytes to matrix of bits. </p>
</div>
</div>
<a id="af64929dff16f07347e6a449f48c78ec9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af64929dff16f07347e6a449f48c78ec9">◆ </a></span>getByteListFromBits()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> cv::aruco::Dictionary::getByteListFromBits </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>bits</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Dictionary_getByteListFromBits(</td><td class="paramname">bits</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Transform matrix of bits to list of bytes in the 4 rotations. </p>
</div>
</div>
<a id="af49505e713e72ead5314216d0c2842d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af49505e713e72ead5314216d0c2842d7">◆ </a></span>getDistanceToId()</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cv::aruco::Dictionary::getDistanceToId </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> </td>
          <td class="paramname"><em>bits</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int </td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool </td>
          <td class="paramname"><em>allRotations</em> = <code>true</code> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns the distance of the input bits to the specific id. If allRotations is true, the four posible bits rotation are considered. </p>
</div>
</div>
<a id="a82348e625eafe407794a4a757168b70d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82348e625eafe407794a4a757168b70d">◆ </a></span>identify()</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool cv::aruco::Dictionary::identify </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> &amp; </td>
          <td class="paramname"><em>onlyBits</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp; </td>
          <td class="paramname"><em>idx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp; </td>
          <td class="paramname"><em>rotation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double </td>
          <td class="paramname"><em>maxCorrectionRate</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Given a matrix of bits. Returns whether if marker is identified or not. It returns by reference the correct id (if any) and the correct rotation. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acd75143ec1fe49467dccc67503a66f07"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd75143ec1fe49467dccc67503a66f07">◆ </a></span>bytesList</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d3/d63/classcv_1_1Mat.html">Mat</a> cv::aruco::Dictionary::bytesList</td>
        </tr>
      </table>
</div><div class="memdoc">
</div>
</div>
<a id="a996eb5d27e061fedf0550092a6149ed7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a996eb5d27e061fedf0550092a6149ed7">◆ </a></span>markerSize</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cv::aruco::Dictionary::markerSize</td>
        </tr>
      </table>
</div><div class="memdoc">
</div>
</div>
<a id="a729196b33a1a678a82f01f8e15d7864b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a729196b33a1a678a82f01f8e15d7864b">◆ </a></span>maxCorrectionBits</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int cv::aruco::Dictionary::maxCorrectionBits</td>
        </tr>
      </table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>opencv2/aruco/<a class="el" href="../../dc/df7/dictionary_8hpp.html">dictionary.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 2 2021 11:36:43 for OpenCV by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="../../doxygen.png"/>
</a> 1.8.13
</small></address>
<script type="text/javascript">
//<![CDATA[
addTutorialsButtons();
//]]>
</script>
</body>
</html>
